/*
 * Copyright 2002-2012 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.web.client;

import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;

import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;

/**
 * Exception thrown when an unknown (or custom) HTTP status code is received.
 *
 * @author Rossen Stoyanchev
 * @since 3.2
 */
public class UnknownHttpStatusCodeException extends RestClientException {

    private static final long serialVersionUID = 4702443689088991600L;

    private static final String DEFAULT_CHARSET = "ISO-8859-1";

    private final int rawStatusCode;

    private final String statusText;

    private final byte[] responseBody;

    private final HttpHeaders responseHeaders;

    private final String responseCharset;


    /**
     * Construct a new instance of {@code HttpStatusCodeException} based on an
     * {@link HttpStatus}, status text, and response body content.
     *
     * @param rawStatusCode   the raw status code value
     * @param statusText      the status text
     * @param responseHeaders the response headers, may be {@code null}
     * @param responseBody    the response body content, may be {@code null}
     * @param responseCharset the response body charset, may be {@code null}
     */
    public UnknownHttpStatusCodeException(int rawStatusCode, String statusText,
                                          HttpHeaders responseHeaders, byte[] responseBody, Charset responseCharset) {

        super("Unknown status code [" + String.valueOf(rawStatusCode) + "]" + " " + statusText);
        this.rawStatusCode = rawStatusCode;
        this.statusText = statusText;
        this.responseHeaders = responseHeaders;
        this.responseBody = responseBody != null ? responseBody : new byte[0];
        this.responseCharset = responseCharset != null ? responseCharset.name() : DEFAULT_CHARSET;
    }

    /**
     * Return the raw HTTP status code value.
     */
    public int getRawStatusCode() {
        return this.rawStatusCode;
    }

    /**
     * Return the HTTP status text.
     */
    public String getStatusText() {
        return this.statusText;
    }

    /**
     * Return the HTTP response headers.
     */
    public HttpHeaders getResponseHeaders() {
        return this.responseHeaders;
    }

    /**
     * Return the response body as a byte array.
     */
    public byte[] getResponseBodyAsByteArray() {
        return responseBody;
    }

    /**
     * Return the response body as a string.
     */
    public String getResponseBodyAsString() {
        try {
            return new String(responseBody, responseCharset);
        } catch (UnsupportedEncodingException ex) {
            // should not occur
            throw new InternalError(ex.getMessage());
        }
    }

}
